///
// * jdbm LICENSE v1.00
// *
// * Redistribution and use of this software and associated documentation
// * ("Software"), with or without modification, are permitted provided
// * that the following conditions are met:
// *
// * 1. Redistributions of source code must retain copyright
// *    statements and notices.  Redistributions must also contain a
// *    copy of this document.
// *
// * 2. Redistributions in binary form must reproduce the
// *    above copyright notice, this list of conditions and the
// *    following disclaimer in the documentation and/or other
// *    materials provided with the distribution.
// *
// * 3. The name "jdbm" must not be used to endorse or promote
// *    products derived from this Software without prior written
// *    permission of Cees de Groot.  For written permission,
// *    please contact cg@cdegroot.com.
// *
// * 4. Products derived from this Software may not be called "jdbm"
// *    nor may "jdbm" appear in their names without prior written
// *    permission of Cees de Groot.
// *
// * 5. Due credit should be given to the jdbm Project
// *    (http://jdbm.sourceforge.net/).
// *
// * THIS SOFTWARE IS PROVIDED BY THE ndbm PROJECT AND CONTRIBUTORS
// * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
// * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
// * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
// * CEES DE GROOT OR ANY CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
// * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
// * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
// * OF THE POSSIBILITY OF SUCH DAMAGE.
// *
// * Copyright 2000 (C) Cees de Groot. All Rights Reserved.
// * Contributions are (C) Copyright 2000 by their associated contributors.
// *
// 

//*************************************************************************
//**  Included in JDMB 1.0 port to SharpDBM;  11/2013 Cyrus Neah cneah@codingreal.com
//**  SharpDBM is an independent reimplementation of the JDBM 1.0 software library in C#  
//*************************************************************************

using System.Runtime.CompilerServices;

namespace SharpDBM.htree
{

	using RecordManager = SharpDBM.RecordManager;
	using FastIterator = SharpDBM.helper.FastIterator;

///
// *  Persistent hashtable implementation for PageManager.
// *  Implemented as an H*Tree structure.
// *
// *  WARNING!  If this instance is used in a transactional context, it
// *            *must* be discarded after a rollback.
// *
// *  @author <a href="mailto:boisvert@intalio.com">Alex Boisvert</a>
// *  @version $Id: HTree.java,v 1.3 2005/06/25 23:12:32 doomdark Exp $
// 
	public class HTree
	{

//    *
//     * Root hash directory.
//     
		private HashDirectory _root;


//    *
//     * Private constructor
//     *
//     * @param root Root hash directory.
//     
		private HTree(HashDirectory root)
		{
			_root = root;
		}


//    *
//     * Create a persistent hashtable.
//     *
//     * @param recman Record manager used for persistence.
//     
 
//
		public static HTree createInstance(RecordManager recman)
		{
			HashDirectory root;
			long recid;

			root = new HashDirectory((sbyte) 0);
			recid = recman.insert(root);
			root.setPersistenceContext(recman, recid);

			return new HTree(root);
		}


//    *
//     * Load a persistent hashtable
//     *
//     * @param recman RecordManager used to store the persistent hashtable
//     * @param root_recid Record id of the root directory of the HTree
//     
 
//
		public static HTree load(RecordManager recman, long root_recid)
		{
			HTree tree;
			HashDirectory root;

			root = (HashDirectory) recman.fetch(root_recid);
			root.setPersistenceContext(recman, root_recid);
			tree = new HTree(root);
			return tree;
		}


//    *
//     * Associates the specified value with the specified key.
//     *
//     * @param key key with which the specified value is to be assocated.
//     * @param value value to be associated with the specified key.
//     
 
//
		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void put(object key, object @value)
		{
			_root.put(key, @value);
		}


//    *
//     * Returns the value which is associated with the given key. Returns
//     * <code>null</code> if there is not association for this key.
//     *
//     * @param key key whose associated value is to be returned
//     
 
//
		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual object @get(object key)
		{
			return _root.get(key);
		}


//    *
//     * Remove the value which is associated with the given key.  If the
//     * key does not exist, this method simply ignores the operation.
//     *
//     * @param key key whose associated value is to be removed
//     
 
//
		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual void remove(object key)
		{
			_root.remove(key);
		}


//    *
//     * Returns an enumeration of the keys contained in this
//     
 
//
		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual FastIterator keys()
		{
			return _root.keys();
		}


//    *
//     * Returns an enumeration of the values contained in this
//     
 
//
		[MethodImpl(MethodImplOptions.Synchronized)]
		public virtual FastIterator values()
		{
			return _root.values();
		}


//    *
//     * Get the record identifier used to load this hashtable.
//     
		public virtual long getRecid()
		{
			return _root.getRecid();
		}

	}


}